home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / texsis / tables / TXSruled.tex < prev   
Text File  |  1992-08-10  |  19KB  |  409 lines
  1. % file: TXSruled.tex            TeXsis                  version 2.14
  2. % $Revision: 1.3 $  :  $Date: 91/06/02 02:22:54 $  :  $Author: myers $
  3. %======================================================================*
  4. %  RULED TABLES.                                E. Myers and F.E. Paige
  5. %
  6. %       The following macros will typeset tables with vertical and
  7. % horizontal rules. The syntax is similar to Ray Cowan's TABLES.TEX,
  8. % but the macros have been completely rewritten. Vertical and horizontal 
  9. % rules are drawn by macros using vertical spacing controlled by struts.
  10. % Usage:
  11. %       \ruledtable
  12. %       <item> <tab> ... <item> <cr>
  13. %       ...
  14. %       <item> <tab> ... <item> \endruledtable
  15. % where <item> is an element of the table (every row must have exactly 
  16. % the same number of items, although some may be blank), <tab> is any
  17. % one of
  18. %     &                 for no vertical rule
  19. %     |  [or \vb]       for vertical rule
  20. %     \| [or \Vb]       for thick vertical rule
  21. %     \dbl              for double vertical rule
  22. % and <cr> is any one of
  23. %     \nr               for no horizontal rule
  24. %     \cr               for horizontal rule
  25. %     \CR [or \crthick] for thick horizontal rule
  26. % The last <cr> must be omitted in favour of the \endruledtable
  27. %
  28. %  For horizontal rules across only some columns use
  29. %       ... \nr
  30. %       \crule | \cskip & \Crule ... \crpart
  31. % where \crpart is a special \cr for the partial rule line and
  32. %       \cskip          no rule for column
  33. %       \crule          horizontal rule for column
  34. %       \Crule          thick horizontal rule for column
  35. % The number of columns must be identical to the other rows.
  36. %
  37. % To change the appearance of the table, modify \TableItem.
  38. % Several modifications are built in:
  39. %       \LeftJustifyTables      left justify each column
  40. %       \RightJustifyTables     right justify each item
  41. %       \NoJustifyTables        center each item (default)
  42. %       \tablespace             horizontal spacing around each item 
  43. %                               (default is \quad)
  44. %       \TightTables            use \ horizontal spacing
  45. %       \LooseTables            use \quad horizontal spacing (default)
  46. %
  47. % Use \bigitem to expand the vertical strut for high or deep items. 
  48. %
  49. %       These macros have been reorganized and substantially revised from
  50. % version 2.13. The following functional changes have been made:
  51. %       (1) The @ signs have been removed from the names of the macros
  52. % used to save the Plain \cr, \span, and & so that they can be used to
  53. % modify the preamble. See above.
  54. %       (2) Macros for partial horizontal rules have been added.
  55. %       (3) \tabskip glue has been added so that \tablewidth works
  56. % correctly -- the table stretches uniformly over all columns.
  57. %       (4) \linecount has been moved to the \cr macros. It produces a
  58. % warning if the number of columns is different from that in the
  59. % previous row.
  60. %       (5) Trailing spaces in the table items are added to the output.
  61. % A macro \NoTrailingSpaces inserts an \unskip after each item to remove
  62. % them. But this also removes trailing skips unless they are followed by
  63. % an empty \hbox or something similar. This is done automatically for 
  64. % an \hfill (frequently used to left justify an item).
  65. %       The default is \TrailingSpaces, but you may wish to insert
  66. % \NoTrailingSpaces in your TXSsite.tex file.
  67. %       (6) \para uses \normalbaselines rather than specific pt values 
  68. % for the interline spacing and the final strut.
  69. %
  70. % (C) copyright 1990, 1991 by Eric Myers and Frank E. Paige
  71. %======================================================================*
  72. % Counters and such:     
  73. \catcode`@=11                                   % @ is a letter here
  74. \catcode`\|=12                                  % make sure | is not active
  75. \catcode`\&=4                                   % and that & is alignment tab
  76.  
  77. \newcount\ncols         \ncols=\z@              % number of columns in table
  78. \newcount\nrows         \nrows=\z@              % number of rows in table
  79. \newcount\curcol        \curcol=\z@             % current column counter
  80. \let\currow=\nrows                              % current row counter
  81.      
  82. \newdimen\thinsize      \thinsize=0.6pt         % thin rule width
  83. \newdimen\thicksize     \thicksize=1.5pt        % thick rule width
  84. \newdimen\tablewidth    \tablewidth=-\maxdimen  % start ``turned off''
  85. \newdimen\parasize      \parasize=4in           % paragraph size in tables
  86.  
  87. \newif\iftableinfo      \tableinfotrue          % report rows and columns? Yes
  88. \newif\ifcentertables   \centertablestrue       % center tables? Yes
  89. \def\centeredtables{\centertablestrue}%
  90. \def\noncenteredtables{\centertablesfalse}%
  91. \def\nocenteredtables{\centertablesfalse}%      % synonym !
  92.      
  93. \let\plaincr=\cr                        % save real \cr
  94. \let\plainspan=\span                    % save real \span
  95. \let\plaintab=&                         % save real alignment tab &
  96. \def\ampersand{\char`\&}%               % to print `&' in text
  97. \let\lparen=(                           % save left paren     
  98. \let\NX=\noexpand                       % shorthand for \noexpand is \NX
  99.  
  100. %---------------------------------------*
  101. % Main macros:
  102. %       \ruledtable <table stuff> \endruledtable turns on the ruled
  103. % table definitions and makes the table with \halign. It handles all
  104. % the control stuff; the real work is done by \@RuledTable.
  105.      
  106. \def\ruledtable{\relax                          % make ruled table
  107.     \@BeginRuledTable                           % initialize table
  108.     \@RuledTable}%                              % now process table body
  109.  
  110. %  \@BeginRuledTable does all the work of setting things up before
  111. % we read in the body of the table
  112.  
  113. \def\@BeginRuledTable{%                         % initialize table
  114.    \ncols=0\nrows=0                             % reset row and column count
  115.    \begingroup                                  % keep the following local
  116.     \offinterlineskip                           % so vrules touch
  117.     \def~{\phantom{0}}%                         % ~ is phantom digit
  118.     \def\span{\plainspan\omit\relax\colcount\plainspan}%  \span USER columns
  119.     \let\cr=\crrule                             % \cr gives a \tablerule
  120.     \let\CR=\crthick                            % \CR gives a \thickrule
  121.     \let\nr=\crnorule                           % \nr give no rule
  122.     \let\|=\Vb                                  % thick vrule between columns
  123.     \def\hfill{\hskip0pt plus1fill\hbox{}}%     % so it is not removed
  124. % 
  125. % support old \tablestrut in place of \tstrut if it exists
  126. %
  127.     \ifx\tablestrut\undefined\relax             % if not defined, no problem
  128.     \else\let\tstrut=\tablestrut\fi             % use \tablestrut
  129. %
  130.     \catcode`\|=13 \catcode`\&=13\relax         % make | and & active
  131.     \TableActive                                % | and & get active \def`s
  132.     \curcol=1                                   % reset column count
  133. %
  134. % define \Halign to do an \halign with or without a width
  135. %
  136.     \ifdim\tablewidth>-\maxdimen\relax          %
  137.       \edef\@Halign{\NX\halign to \NX\tablewidth\NX\bgroup\TablePreamble}% 
  138.       \tabskip=0pt plus 1fil                    % let things stretch
  139.     \else                                       %
  140.       \edef\@Halign{\NX\halign\NX\bgroup\TablePreamble}% 
  141.       \tabskip=0pt                              % no stretch between columns
  142.     \fi                                         %
  143. %
  144. % center text if needed
  145. %
  146.     \ifcentertables                             % should table be centered?
  147.        \ifhmode\vskip 0pt\fi                    % yes: force vertical mode
  148.        \line\bgroup\hss                         % center across page
  149.     \else\hbox\bgroup                           % else: just put in \hbox
  150.     \fi}%                                       % end of \@BeginRuledTable
  151.  
  152.  
  153. %       \@RuledTable builds the table with \@Halign and getting the
  154. % table body text as its argument.
  155.  
  156. \long\def\@RuledTable#1\endruledtable{%         % ruled table alignment
  157.    \vrule width\thicksize                       % thick rule on side
  158.      \vbox{\@Halign                             % then do \halign
  159.        \thickrule                               % thick rule on top
  160.        #1\killspace                             % body of table
  161.        \tstrut                                  % vertical strut for last line
  162.        \linecount                               % count this line
  163.        \plaincr\thickrule                       % \cr, thick rule on bottom
  164.      \egroup}%                                  % end of \halign and \vbox
  165.    \vrule width\thicksize                       % thick rule on side, end \hbox
  166.    \ifcentertables\hss\fi\egroup                % finish table centering
  167.   \endgroup                                     % end group from \ruledtable
  168.   \global\tablewidth=-\maxdimen                 %   and reset width
  169.   \iftableinfo                                  % report rows and columns
  170.       \immediate\write16{[Nrows=\the\nrows, Ncols=\the\ncols]}%
  171.    \fi}%                                        % end of \@RuledTable
  172.      
  173. %---------------------------------------*
  174. % Preamble and item macros:
  175. %       \TablePreamble is the preamble for the \halign in \ruledtable. 
  176. %       To change how each item is processed change \TableItem.  
  177. %       To make a more complicated table you can change \TablePreamble,
  178. % but if you do so use the following substitutions in a standard \halign 
  179. % preamble:
  180. %    for  &     use     \plaintab
  181. %    for  \cr   use     \plaincr
  182. %    for  #     use     ##
  183. %    for  ##    use     ####
  184.  
  185. \def\TablePreamble{%                    % \ruledtable preamble
  186.    \TableItem{####}%                    % the first item
  187.    \plaintab\plaintab                   % && means repeat this
  188.    \TableItem{####}%                    % the subsequent items
  189.    \plaincr}%                           % end of preamble
  190.  
  191.  
  192. %       \TableItem contains glue or spacing around the item
  193.  
  194. \def\@TableItem#1{%                     % centers item in ruled table
  195.    \hfil\tablespace                     % left glue
  196.    #1\killspace%                        % item
  197.    \tablespace\hfil                     % right glue
  198.     }%
  199.  
  200. \def\@tableright#1{%                    % right justifies item in ruled table
  201.    \hfil\tablespace\relax               % left glue
  202.    #1\killspace%                        % item
  203.    \tablespace\relax}%                  % right glue
  204.  
  205. \def\@tableleft#1{%                     % left justifies item in ruled table
  206.    \tablespace\relax                    % left glue
  207.    #1\killspace%                        % item
  208.    \tablespace\hfil}%                   % right glue
  209.  
  210. \let\TableItem=\@TableItem              % default is centered
  211.      
  212. \def\RightJustifyTables{\let\TableItem=\@tableright}%   % to right justify
  213. \def\LeftJustifyTables{\let\TableItem=\@tableleft}%     % to left justify
  214. \def\NoJustifyTables{\let\TableItem=\@TableItem}%       % to center
  215.  
  216.  
  217. %       \TightTables makes the spacing of a table as tight as possible.
  218. % \LooseTables, the default, gives more pleasing spacing.
  219.  
  220. \def\LooseTables{\let\tablespace=\quad}%        % table spacing is \quad
  221. \def\TightTables{\let\tablespace=\space}%       % table spacing is space
  222. \LooseTables                                    % default is \quad
  223.  
  224.  
  225. %       \TrailingSpaces, the default, allows trailing spaces and glue
  226. % to change the appearance of a table. \NoTrailingSpaces removes all
  227. % trailing spaces and glue before inserting the table glue.
  228.  
  229. \def\TrailingSpaces{\let\killspace=\relax}      % do not kill trailing space
  230. \def\NoTrailingSpaces{\let\killspace=\unskip}   % kill trailing space
  231. \TrailingSpaces                                 % default
  232.  
  233. %---------------------------------------*
  234. % Table Height and Width:
  235. %
  236. %  Normally tables are set to their natural width.  If \tablewidth
  237. %  has been set then we set the table to that width instead,
  238. %  but only for the next table.  Then \tablewidth is turned off
  239.  
  240. %      \setRuledStrut sets up the vertical strut \tstrut with
  241. % the appropriate dimensions to hold up one line of a ruled table. 
  242.  
  243. \def\setRuledStrut{% sets interlines spacing for ruled tables
  244.    \dimen@=\baselineskip                        % \dimen@ = extra space
  245.    \advance\dimen@ by-\normalbaselineskip       % between lines
  246.    \ifdim\dimen@<.5ex \dimen@=.5ex\fi           % minimum space
  247.    \setbox0=\hbox{\lparen}%                     % get character size
  248.    \dimen1=\dimen@ \advance\dimen1 by \ht0      % space above line
  249.    \dimen2=\dimen@ \advance\dimen2 by \dp0      % space below line
  250.    \def\tstrut{\vrule height\dimen1 depth\dimen2 width\z@}%
  251.    }%
  252.  
  253. \def\tstrut{\vrule height 3.1ex depth 1.2ex width 0pt}%  default
  254.  
  255.  
  256. %      \tstrut does not produce the correct spacing if the entry in
  257. % the table is too high. The following constructs a strut higher than its
  258. % argument and then prints the argument. The minimum space value should
  259. % be the same as in \setRuledStrut. 
  260.  
  261. \def\bigitem#1{%                                % larger table entry
  262.    \dimen@=\baselineskip                        % \dimen@ = extra space
  263.    \advance\dimen@ by-\normalbaselineskip       % between lines
  264.    \ifdim\dimen@<.5ex \dimen@=.5ex\fi           % minimum space
  265.    \setbox0=\hbox{#1}%                          % get argument size
  266.    \dimen1=\dimen@ \advance\dimen1 by \ht0      % space above line
  267.    \dimen2=\dimen@ \advance\dimen2 by \dp0      % space below line
  268.    \vrule height\dimen1 depth\dimen2 width\z@   % make strut to size
  269.    \copy0}%                                     % print argument
  270.  
  271.  
  272. %       \vctr{stuff} centers the stuff vertically, so that it can
  273. % appear between two ROWS.
  274.      
  275. \def\vctr#1{\hfil\vbox to 0pt{\vss\hbox{#1}\vss}\hfil}%
  276.  
  277. %---------------------------------------*
  278. % Vertical rules:
  279. %       \tab, \vb and \Vb are used in a table to separate columns with no
  280. % rule, a thin rule, or a thick rule, respectively.  \nextcolumn{<rule>} skips
  281. % to  the next column and puts the <rule> between columns.  Use this to build
  282. % your own separators.
  283.      
  284. \def\nextcolumn#1{%                             % move to next col.
  285.    \plaintab\omit#1\relax\colcount              % tab, insert #1, count
  286.    \plaintab}%                                  % tab to next user col.
  287.      
  288. \def\tab{%                                      % no rule between columns
  289.    \nextcolumn{\relax}}%                        % count column
  290.  
  291. \let\novb=\tab                                  % synonym for \tab
  292.  
  293. \def\vb{%                                       % thin rule between columns
  294.    \nextcolumn{\vrule width\thinsize}}%         % count and rule
  295.  
  296. \def\Vb{%                                       % THICK rule between columns
  297.    \nextcolumn{\vrule width\thicksize}}%        % count and thick rule
  298.  
  299. \def\dbl{%                                      % double rule between columns
  300.    \nextcolumn{\vrule width\thinsize            % count and rule
  301.    \hskip\thinsize\vrule width\thinsize}}%      % and skip and rule
  302.  
  303. %       \TableActive makes | the same as \vb and & the same as \tab so
  304. % these single characters can be used between columns. Here we have to
  305. % make & and | active so we get the active version of the characters,
  306. % hence the temporary change of \catcode.
  307.      
  308. {\catcode`\|=13 \let|0
  309.  \catcode`\&=13 \let&0
  310.  \gdef\TableActive{\let|=\vb \let&=\tab}%
  311. }% end \catcode`s
  312.  
  313. %---------------------------------------*
  314. % Horizontal rules:
  315. %       These replacements for \cr put a wide \vrule at the end of the
  316. % line and maybe put a rule under the line, then begin the next line
  317. % with the wide \vrule from the preamble.
  318.      
  319.  
  320. \def\crrule{\killspace                  % \cr plus rule
  321.    \tstrut                              % strut for spacing
  322.    \linecount                           % count this line
  323.    \plaincr\tablerule                   % \cr, regular rule below line
  324.   }%
  325.  
  326. \def\crthick{\killspace                 % \cr plus thick rule
  327.    \tstrut                              % strut for vertical spacing
  328.    \linecount                           % count this line
  329.    \plaincr\thickrule                   % \cr, rule, begin next line
  330.   }%                
  331.      
  332. \def\crnorule{\killspace                % \cr plus no rule
  333.    \tstrut                              % strut for spacing
  334.    \linecount                           % count this line
  335.    \plaincr                             % \cr, norule, begin next line
  336.    }%
  337.    
  338. \def\crpart{\killspace                  % end partial rule line
  339.    \linecount                           % count this line
  340.    \plaincr}                            % and end it
  341.  
  342.  
  343. %       These rules go across the table.
  344.      
  345. \def\tablerule{\noalign{\hrule height\thinsize depth 0pt}}%
  346. \def\thickrule{\noalign{\hrule height\thicksize depth 0pt}}%
  347.  
  348.  
  349. %       Rules for individual columns. You must use \cskip in columns
  350. % with no rules to \omit the \TablePreamble.
  351.  
  352. \def\cskip{\omit\relax}%
  353. \def\crule{\omit\leaders\hrule height\thinsize depth0pt\hfill}%
  354. \def\Crule{\omit\leaders\hrule height\thicksize depth0pt\hfill}%
  355.      
  356. %---------------------------------------*
  357. % Counting macros:     
  358. %       These macros count rows and columns of the table. After the
  359. % first line has been processed \the\ncols is the total number of
  360. % columns in the table, which may be useful. During processing,
  361. % \the\curcol is the number of the current column, while \the\currow is
  362. % the number of the current row.
  363.      
  364.  
  365. \def\linecount{%                                % count and check row
  366.    \global\advance\nrows by1%                   % advance row counter
  367.    \ifnum\ncols>0%                              % if \ncols set
  368.       \ifnum\curcol=\ncols\relax\else           % if new \ncols different
  369.       \immediate\write16%                       %   then write message
  370.       {\NX\ruledtable warning: Ncols=\the\curcol\space for Nrow=\the\nrows}%
  371.       \fi\fi                                    % end of tests
  372.    \global\ncols=\curcol                        % save columns in \ncols
  373.    \global\curcol=1}                            % reset counter
  374.  
  375. \def\colcount{\relax                            %
  376.    \global\advance\curcol by 1\relax}%          % advance column counter
  377.  
  378. %---------------------------------------*
  379. % TEXT TABLES.
  380. %       To put text in a table use \para{<text>}, with \parasize set
  381. %  to the desired width of the text.
  382.  
  383. \long\def\para#1{%                      % make a paragraph for tables
  384.    \vtop{\hsize=\parasize               % width - set before \para called
  385.    \normalbaselines                     % set normal baseline skips
  386.    \noindent #1\relax                   % insert text
  387.    \vrule width 0pt depth 1.1ex}%       % hold depth of box
  388. }%
  389.  
  390. %---------------------------------------*
  391. % TABLES.TEX
  392. %   For compatability with Cowan's TABLES.TEX we also allow the
  393. % syntax \begintable ... \endtable, which do the same thing.
  394. %
  395.  
  396. \def\begintable{\relax                          % make ruled table
  397.     \@BeginRuledTable                           % initialize table
  398.     \@begintable}%                              % now process table body
  399.  
  400. \long\def\@begintable#1\endtable{%              % ruled table alignment
  401.    \@RuledTable#1\endruledtable}%               % same as \ruledtable
  402.  
  403. %---------------------------------------*
  404. % Turn off @ as letter before we exit
  405.  
  406. \catcode`@=12                                   % @ is not a letter
  407.  
  408. %>>> EOF TXSruled.tex <<<
  409.